Javadoc should be used for classes, class variables and methods. The format should be '/** comment **/', rather than '// xxx'.
<p>Examples:</p>
<pre>
/**
*
* XXX class function description.
*
*/
public class XxClass implements Serializable {
   private static final long serialVersionUID = 113323427779853001L;
   /**
   * id
   */
   private Long id;
   /**
   * title
   */
   private String title;
   /**
   * find by id
   *
   * @param ruleId rule id
   * @param page start from 1
   * @return Result<Xxxx>
   */
   public Result<Xxxx> funcA(Long ruleId, Integer page) {
       return null;
   }
}
</pre>